[9.x] Implement Symfony Mailer #38481

driesvints · 2021-08-20T16:24:07Z

This PR replaces SwiftMailer with Symfony Mailer. Special thanks to @Jubeki for his help with this PR.

See https://symfony.com/blog/the-end-of-swiftmailer

Todo

Convert SES transport to symfony/amazon-mailer
Convert MailgunTransport to symfony/mailgun-mailer
Convert PostmarkTransport to symfony/postmark-mailer
Solve all concerns in this thread
Test all transports
Add support for Postmark's Message Streams when Implement Message Stream for Postmark Mailer symfony/symfony#42941 is merged
Add support for session tokens in the SES transport when Add Session Token to Amazon Mailer symfony/symfony#42982 is merged

Breaking changes

send, html, text & plain don't return the number of recipients anymore but an instance of Illuminate\Mail\SentMessage which contains the Symfony\Component\Mailer\SentMessage instance
All Swift methods were renamed to Symfony
The Illuminate\Mail\Message class now contains an instance of Symfony\Component\Mime\Email instead of Swift_Message so all forwarding calls in userland will need to be updated
SwiftMailer plugins will no longer work
Setting the auth_mode in the mail config was removed (see [Mailer] Remove the auth mode DSN option and support in the eSMTP transport symfony/symfony#33237)
It's no longer possible to get a list of failed recipients. Instead, if an email is failed to send, and exception will be thrown (see [Mailer] Get failing email addresses symfony/symfony#33812)
Setting stream options for the SMTP transport can no longer be done through an smtp key. Instead you need to set the options directly in the config. For example, when disabling TLS peer verification (see [Mailer] add ability to disable the TLS peer verification via DSN symfony/symfony#35262)
SwiftMailer offered the ability to set a custom domain to generate Message ID's through register it to mime.idgenerator.idright. This is no longer possible with Symfony Mailer. Instead, Symfony Mailer will automatically generate a Message ID based on the sender and add it to a message automatically (see [9.x] Implement Symfony Mailer #38481 (comment))
It is no longer possible to force a reconnection (for example when the mailer is running through a daemon process). Instead, Symfony Mailer will properly attempt to reconnect the transport itself and error out if that fails (see [9.x] Implement Symfony Mailer #38481 (comment) and [9.x] Implement Symfony Mailer #38481 (comment)).

Possible improvements

✅ ~~We could wrap Symfony\Component\Mailer\SentMessage to add some nice API methods like retrieving recipients, etc~~
It might be interesting to provide support for MAILER_DSN strings to set up transports. This will allow much more thorough configuration for transports and we could at the same time provide BC support for the old configuration schemes.

Design Choices

Symfony Mailer vs Symfony Transport

Previously a Swift_Mailer instance was provided to the laravel Mailer instance. I didn't opt to instantiate a Symfony Mailer instance because in some situations you'd need to interact with the transport (like the array and log transport) and there's no getter for the transport on the Symfony Mailer instance. Since we don't use the Symfony logger or events functionality, I decided to pass the TransportInterface instead. You can think of Laravel's Mailer class to be a direct replacement for Symfony's Mailer class.

Docs

laravel/docs#7306

src/Illuminate/Mail/Message.php

michael-rubel

A lot of duplicates with $this->email->method.
Maybe it's better to create a separate method with passing cc, bcc, etc?

driesvints · 2021-08-26T13:07:53Z

A lot of duplicates with $this->email->method.

@michael-rubel it's fine as is I think.

src/Illuminate/Mail/MailManager.php

src/Illuminate/Mail/Message.php

src/Illuminate/Mail/MailManager.php

src/Illuminate/Mail/Mailer.php

tests/Integration/Mail/SendingMailWithLocaleTest.php

composer.json

taylorotwell · 2021-09-03T16:23:35Z

I don't think we can remove this: The Postmark X-PM-Message-Stream header won't be set anymore (see [8.x] Make it possible to set Postmark Message Stream ID #35755)

If the Symfony version of the Postmark driver doesn't support it we should probably just write our own Postmark transport for Symfony Mailer.

Jubeki · 2021-09-03T16:40:41Z

I don't think we can remove this: The Postmark X-PM-Message-Stream header won't be set anymore (see [8.x] Make it possible to set Postmark Message Stream ID #35755)

If the Symfony version of the Postmark driver doesn't support it we should probably just write our own Postmark transport for Symfony Mailer.

You probably would only need to change the getPayload function for the Postmark(API) Transport.
https://github.com/symfony/postmark-mailer/blob/bd270db549b314e60da8991485137d68dbbd68de/Transport/PostmarkApiTransport.php#L77-L116

There you would need to add the key MessageStream (https://postmarkapp.com/developer/api/email-api)

If you were using the Postmark SMTP Transport it would still be possible to use the header like before. (https://postmarkapp.com/developer/user-guide/send-email-with-smtp in the Section Connection-Details)

Edit: Maybe doing a PR to Symfony would be an idea.

Jubeki · 2021-09-06T11:40:50Z

@driesvints Regarding the Postmark X-PM-Message-Stream header.

The current Swift Mailer Implementation of the Postmark Transport also works with the API. There it also just attaches the Header to the request and it seems to be working fine right now.
Because Symfony Postmark Mailer works the same way as the Swift Version. The headers are attached to the request and it may just work out of the box.
I can't verify this because I never worked with Postmark before and don't have an account there.

Edit: I also can't find any documentation regarding this. This could change anytime if Postmark would want to.

driesvints · 2021-09-08T15:07:43Z

@Jubeki thanks for all your investigation. I did some of my own and it turns out that Message Streams are a documented feature after all. I've sent a PR to Symfony to provide support for it and all the details are in the PR: symfony/symfony#42941

Jubeki · 2021-09-08T15:20:22Z

@driesvints yeah it is documented for sure. What I meant was that the current implementation (Laravel 8.x) uses the X-PM-Message-Stream header together with the Postmark API. I only found documentation for the Header in the SMTP Section of Postmark and not in the API Section. So I was just wondering how the current Implementation is even working as intended.

driesvints · 2021-09-08T15:26:07Z

@Jubeki I guess Postmark both accepts a X-PM-Message-Stream header and a MessageStream value set on its payload for the API endpoint. Either will set the Message Stream I suspect.

Jubeki · 2021-09-08T15:26:25Z

Also maybe another concern which should be addressed:

What if somebody sets the X-PM-Message-Stream header on a email instance. Which value will be choosen?
In Laravel 8.x the header would overwrite the default.

With the new implementation in 9.x there is both the header and the json entry present. Which has a higher priority?
Maybe the header should be transformed into a MessageStreamHeader or be filtered out to overwrite the default?

Co-authored-by: Julius Kiekbusch <jubeki99@gmail.com>

* Create SentMessage wrapper for Symfony's SentMessage * Wrap Symfony SentMessage * Update Docblocks to Illuminate\Mail\SentMessage * Fix sendMailable * Update SentMessage.php Co-authored-by: Dries Vints <dries@vints.io>

driesvints · 2021-09-14T09:32:59Z

@taylorotwell @Jubeki has added the SentMessage instance. I suggest adding the new methods to it later on in a separate PR so we don't let this PR become too large.

taylorotwell · 2021-09-14T13:57:39Z

@Jubeki thanks for all your help with this! ❤️

Jubeki · 2021-09-14T14:01:21Z

I also have to say thanks to you @taylorotwell and @driesvints. You are doing really great work with Laravel.

Learning by doing is the best way to learn for me. Even more so if you don't want to work on your bachelor thesis or learn for your exams. 😂

driesvints · 2021-09-14T14:03:15Z

Thanks a lot for all your help @Jubeki!

See laravel/framework#38481

dyanakiev · 2022-01-24T14:00:00Z

@driesvints hey, i think there could be issue with this.
Im simple doing:

Mail::to(['me@gmail.com'])->send(new test());

and i get this error: Object of class Symfony\Component\Mime\Address could not be converted to string on that line above.
Im using "laravel/framework": "^9.0", i also tried multiple different ways and the issue is always the same, alsso theres no way to specify recipient name?
This should be working as per the docs.

I also tried from symfony docs:

        Mail::to(new Address('me@gmail.com'))->send(new test());

But then i get Undefined property: Symfony\Component\Mime\Address::$email

Jubeki · 2022-01-24T14:08:33Z

@dyanakiev I just tried your example on a fresh Laravel 9 App and it seems to be working fine. Can you please provide a repository?

If you have GitHub CLI:

laravel new bug-symfony-mailer --dev --github="--public"

If you don't have GitHub CLI:

laravel new bug-symfony-mailer --dev
git init
git add .
git commit -m "Setup Laravel Project"

Then add your changes and commit them.

You can also take a look at: https://github.com/Jubeki/bug-symfony-mailer

composer install
cp .env.example .env
php artisan key:generate
php artisan mail

Then take a look in storage/logs/laravel.log

dyanakiev · 2022-01-24T14:25:11Z

@Jubeki thanks, i just tried with your repo and theres no issue, im really confused about what is happening..

Sorry i found the issue i forgot to look at the stacktrace.. it was clockwork fault...

mohdkasim01911 · 2023-04-03T06:09:13Z

Method Illuminate\Mail\Mailer::getSwiftMailer does not exist.

i have error please give me solution

michael-rubel reviewed Aug 21, 2021

View reviewed changes

src/Illuminate/Mail/Message.php Outdated Show resolved Hide resolved